array( 'view', 'edit' ), 'readonly' => true, ), 'extended_info' => array( 'code' => array( 'type' => 'string', 'readonly' => true, 'context' => array( 'view', 'edit' ), 'description' => __( 'Coupon code.', 'woocommerce' ), ), 'date_created' => array( 'type' => 'date-time', 'readonly' => true, 'context' => array( 'view', 'edit' ), 'description' => __( 'Coupon creation date.', 'woocommerce' ), ), 'date_created_gmt' => array( 'type' => 'date-time', 'readonly' => true, 'context' => array( 'view', 'edit' ), 'description' => __( 'Coupon creation date in GMT.', 'woocommerce' ), ), 'date_expires' => array( 'type' => 'date-time', 'readonly' => true, 'context' => array( 'view', 'edit' ), 'description' => __( 'Coupon expiration date.', 'woocommerce' ), ), 'date_expires_gmt' => array( 'type' => 'date-time', 'readonly' => true, 'context' => array( 'view', 'edit' ), 'description' => __( 'Coupon expiration date in GMT.', 'woocommerce' ), ), 'discount_type' => array( 'type' => 'string', 'readonly' => true, 'context' => array( 'view', 'edit' ), 'enum' => array_keys( wc_get_coupon_types() ), 'description' => __( 'Coupon discount type.', 'woocommerce' ), ), ), ), ); return $this->add_additional_fields_schema( $schema ); } /** * Get the query params for collections. * * @return array */ public function get_collection_params() { $params = parent::get_collection_params(); $params['orderby']['default'] = 'coupon_id'; $params['orderby']['enum'] = array( 'coupon_id', 'code', 'amount', 'orders_count', ); $params['coupons'] = array( 'description' => __( 'Limit result set to coupons assigned specific coupon IDs.', 'woocommerce' ), 'type' => 'array', 'sanitize_callback' => 'wp_parse_id_list', 'validate_callback' => 'rest_validate_request_arg', 'items' => array( 'type' => 'integer', ), ); $params['extended_info'] = array( 'description' => __( 'Add additional piece of info about each coupon to the report.', 'woocommerce' ), 'type' => 'boolean', 'default' => false, 'sanitize_callback' => 'wc_string_to_bool', 'validate_callback' => 'rest_validate_request_arg', ); return $params; } /** * Get the column names for export. * * @return array Key value pair of Column ID => Label. */ public function get_export_columns() { $export_columns = array( 'code' => __( 'Coupon code', 'woocommerce' ), 'orders_count' => __( 'Orders', 'woocommerce' ), 'amount' => __( 'Amount discounted', 'woocommerce' ), 'created' => __( 'Created', 'woocommerce' ), 'expires' => __( 'Expires', 'woocommerce' ), 'type' => __( 'Type', 'woocommerce' ), ); /** * Filter to add or remove column names from the coupons report for * export. * * @since 1.6.0 */ return apply_filters( 'woocommerce_report_coupons_export_columns', $export_columns ); } /** * Get the column values for export. * * @param array $item Single report item/row. * @return array Key value pair of Column ID => Row Value. */ public function prepare_item_for_export( $item ) { $date_expires = empty( $item['extended_info']['date_expires'] ) ? __( 'N/A', 'woocommerce' ) : $item['extended_info']['date_expires']; $export_item = array( 'code' => $item['extended_info']['code'], 'orders_count' => $item['orders_count'], 'amount' => $item['amount'], 'created' => $item['extended_info']['date_created'], 'expires' => $date_expires, 'type' => $item['extended_info']['discount_type'], ); /** * Filter to prepare extra columns in the export item for the coupons * report. * * @since 1.6.0 */ return apply_filters( 'woocommerce_report_coupons_prepare_export_item', $export_item, $item ); } }